/*
 * The MIT License
 *
 * Copyright 2018 Intuit Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.intuit.karate.core;

import com.intuit.karate.Results;
import com.intuit.karate.http.HttpRequestBuilder;

/**
 *
 * @author pthomas3
 */
public interface ExecutionHook {
    
    /**
     * 
     * @param scenario
     * @param context 
     * @return false if the scenario / feature should be excluded from the test-run
     * @throws RuntimeException (any) to abort the scenario
     */
    boolean beforeScenario(Scenario scenario, ScenarioContext context);
    
    void afterScenario(ScenarioResult result, ScenarioContext context);
    
    boolean beforeFeature(Feature feature, ExecutionContext context);
    
    void afterFeature(FeatureResult result, ExecutionContext context);
    
    void beforeAll(Results results);
    
    void afterAll(Results results);
    
    boolean beforeStep(Step step, ScenarioContext context);
    
    void afterStep(StepResult result, ScenarioContext context);
    
    String getPerfEventName(HttpRequestBuilder req, ScenarioContext context);
    
    void reportPerfEvent(PerfEvent event);
    
}
